home *** CD-ROM | disk | FTP | other *** search
/ Precision Software Appli…tions Silver Collection 1 / Precision Software Applications Silver Collection Volume One (PSM) (1993).iso / games / egavga / 1993tris.arj / MP.DOC < prev    next >
Text File  |  1991-10-23  |  20KB  |  456 lines
  1.  
  2.  
  3.      MODPLAY  *********                            (C) Mark J Cox
  4.      MODPLAY  **                                        1990/1991
  5.      MODPLAY  *******                              
  6.      MODPLAY  **************                       Version 2.03
  7.  
  8.      Play AMIGA 4 channel music files on a PC
  9.  
  10.  
  11.      I. QUICK START
  12.      ─────────────────────────────────────────────────────────
  13.  
  14.      If you are impatient and don't want to read all the documentation before 
  15.      trying this program, type:
  16.  
  17.                 mp -i            
  18.      or         mp -a-i   If your machine is 10Mhz - 12Mhz
  19.      or         mp -s-i   If you have a SoundBlaster Card installed
  20.  
  21.  
  22.  
  23.      II. EXTRA INFORMATION
  24.      ─────────────────────────────────────────────────────────
  25.  
  26.      1          On startup some machines think they have a Soundblaster
  27.                 card installed even if they do not.  If you do not have
  28.                 a Soundblaster card but it thinks you do, please do not
  29.                 use the -s option or change output device to Soundblaster
  30.                 (it may hang up your machine and you will have to reboot)
  31.  
  32.      2          If your video card supports text modes such as 25*132,
  33.                 44*132, 60*132 or just about any other text mode then enter
  34.                 this mode (using the utility supplied with your card) and
  35.                 MODPLAY will take full advantage of it.
  36.  
  37.      3          If you have received MODPLAY with any commercial product 
  38.                 (excluding DABS PRESS and Activision/Infocom)  please 
  39.                 let me know as soon as possible.  This software has been
  40.                 written to be distributed freely (subject to License at end
  41.                 of this document) - not so companies can make lots of money
  42.                 out of it themselves.
  43.  
  44.  
  45.      III.  INTRODUCTION TO MODPLAY
  46.      ─────────────────────────────────────────────────────────
  47.  
  48.      Modplay allows you to play Amiga soundtracker/noisetracker files
  49.      (or 4 channel Startrekker files) on a PC (10Mhz or faster clock speed).  
  50.      Modplay is written *entirely* in assembler and now runs to over
  51.      7,000 lines of source and has taken around 300 hours to produce.
  52.  
  53.  
  54.  
  55.      1.   WHAT ARE MODULES?
  56.      ─────────────────────────────────────────────────────────
  57.  
  58.      A module consists of 15 (or 31) sampled instruments and a four channel
  59.      music track.  By playing the instruments at different pitches a
  60.      soundtrack lasting many minutes can be produced.  The PC speaker is not
  61.      really up to handling modules, since in total we have a 10 bit sample
  62.      to be played, and the speaker can only handle 5 (and thats only just
  63.      possible).  A D/A converter gives 8 and the stereo version gives 
  64.      effectively 9. The output sounds OK through a good sized PC speaker, the 
  65.      cheap piezo devices found in some computers including laptops are not 
  66.      really designed to cope.  So through external harware MODPLAY comes 
  67.      close to the quality you would get on an AMIGA.
  68.  
  69.  
  70.      2. IMPLEMENTATION
  71.      ─────────────────────────────────────────────────────────
  72.  
  73.      MODPLAY implements all Amiga effects such as volume sliding, vibrato etc.
  74.      Most Amiga modules have samples in them that are less than 64k each in
  75.      length, these can be played as normal on any 286 10Mhz or better;  a
  76.      rare few have samples >64k in them and although these will be played
  77.      by modplay you really need a 16MHz machine minimum to keep up.  These 
  78.      modules are marked with a '*' on the top line of the display next to the
  79.      filename when they are playing.
  80.  
  81.  
  82.  
  83.      3. MODPLAY OPTIONS - COMMAND LINE PLAYING
  84.      ─────────────────────────────────────────────────────────
  85.  
  86.      From the command line a module can be played through any of the output
  87.      devices with or without a moving graph display.  The format is 
  88.  
  89.      MP [-q] [-0..6] [-a/-b] filename [.MOD]
  90.  
  91.      Items in [ ] are optional.   The -q if present tells MODPLAY not to
  92.      display any text and so the module will play without disturbing the
  93.      text display.  (You could use this in a game's title screen written
  94.      in C or Basic, by doing a system or shell command - MODPLAY exits when
  95.      a key is pressed).  The -(number) tells MODPLAY what hardware to play
  96.      the module through.  The filename can contain wildcard characters
  97.      (*,?), so MODPLAY * would be valid and would play all the *.MOD files
  98.      in the current directory one after the other.  Playback of a sequence
  99.      of files can be aborted by pressing ESCape two or three times in rapid
  100.      sucession.  
  101.  
  102.      -0  is the PC Speaker (default unless a stereo-on-one card is found)
  103.      -l1 is a D/A converter on printer port 1
  104.      -l2 is a D/A converter on printer port 2
  105.      -l3 is a D/A converter on printer port 3
  106.      -l4 is a D/A converter on printer port 4
  107.      -ls is 2 D/A converters, one on port1 the other on port2 (gives stereo)
  108.      -lm is 2 D/A converters as above but giving mono.
  109.      -s is a Soundblaster card (any base address 210-260 is detected)
  110.  
  111.      -xm
  112.        This is of use if you have a single D/A converter on an expansion
  113.        port or any known address.  Use -xm(address) where the address is
  114.        a 3 digit hex number.  (Example -xm3B7 would play in mono to a
  115.        D/A converter at address 03B7) 
  116.     
  117.      -xs
  118.        This is similar to -xm, allowing two D/A converters and hence stereo
  119.        operation.  Use -xs(address1)(address2).  [Example, -xs300301 would
  120.        play in stereo to D/A converters at 0300 and 0301.  Note that these
  121.        switchs must be used from the command line and cannot be changed when
  122.        inside MODPLAY
  123.  
  124.      Stereo-on-1
  125.        Modplay will autodetect a Stereo-on-1 board on any Parallel port and
  126.        use it.  See HARDWARE.DOC for more information
  127.  
  128.      Soundblaster
  129.        Modplay will autodetect a Soundblaster card at any base address and
  130.        use it. 
  131.  
  132.      (Using a /number will ignore anything autodetected).
  133.  
  134.      -a should be used if your computer crashes when playing tunes, it
  135.         decreases the rate of playing samples - decreasing the quality
  136.         noticably through the speaker, but should mean 10Mhz-12Mhz machines
  137.         can cope.
  138.      -b This is the default mixing speed designed for a 12MHz PC
  139.  
  140.      -d This option is used when if you don't like my choice of character 
  141.         for drawing the bars.  I've had lots of mail all saying you would
  142.         like different characters - so now you can choose your own,
  143.         Usage is -dxx where xx is a two-digit hexidecimal number of the 
  144.         character you want to use,
  145.  
  146.         -dF0    Would be ≡, the default bar
  147.         -df7    Would be ≈, one of my favorites
  148.         -d02    is quite fun for 'acid house' type mods. 
  149.  
  150.         And if you are still not satisfied, then pressing F1 or F2 when
  151.         playing changes the character as well!  F3 and F4 even change the
  152.         colour of the moving bar.  Hours of fun (yawn)!
  153.  
  154.      Playing is stopped by pressing *any* key, or when the module is finished
  155.      Modules that loop at the end, or jump backwards are stopped so they
  156.      will only play once.
  157.  
  158.      There are some special keys, described in the next section that can
  159.      be used to whiz through a module like a CD player.
  160.  
  161.  
  162.  
  163.      4. MODPLAY IN INTERACTIVE MODE
  164.      ─────────────────────────────────────────────────────────
  165.  
  166.      MP -i will bring up a display menu screen - help on all key presses
  167.      is available by pressing F1.   From this screen you can change
  168.      directory, change drive or play one or more modules.
  169.  
  170.      The commands allowed are:
  171.  
  172.      Basic Keys:
  173.  
  174.  
  175.      Cursor Keys Move the highlight bar together with the 'PgUp',
  176.                  'PgDn', 'Home' and 'End' keys.
  177.  
  178.      <SPACE>     This will play the current module highlighted, or change
  179.                  to the directory or drive hightlighted
  180.  
  181.      <ESC>       Quits modplay
  182.  
  183.      <c>         Brings up a menu showing all the possible output devices.
  184.                  Lets you move around them using the arrow keys and select
  185.                  one by pressing SPACE or RETURN.
  186.  
  187.      <!>         Lets you perform DOS commands.
  188.  
  189.   
  190.      Advanced:
  191.  
  192.  
  193.      <t>         Tags the currently highlighted module (displays a "+")
  194.                  or untags the module if already tagged.
  195.  
  196.      <T>         Tags all modules in directory
  197.  
  198.      <U>         Untags all modules in directory
  199.  
  200.      <p>         Plays all tagged modules in sequence.
  201.  
  202.      <s>         Takes you into the Sample sub-menu screen
  203.  
  204.  
  205.      Sample Sub-menu:
  206.  
  207.  
  208.      From here you can look at the samples that make up the module - there
  209.      are a few special keys that perform various functions that are not
  210.      fully tested and are provided for users that know what they are
  211.      doing (i.e. not bomb proof input routines!)
  212.  
  213.      <p>         Plays the sample highlighted
  214.  
  215.      <m>         Plays the whole module
  216.  
  217.      <w>         Prompts for a filename and then saves the sample to disk
  218.  
  219.      <r>         Reads a new sample into the old slot.
  220.  
  221.  
  222.  
  223.      5. PLAYBACK KEYS
  224.      ───────────────────────────────────────────────────────── 
  225.  
  226.      During any playback, pressing the left arrow key will slow the music
  227.      down, the right arrow key will speed it up and the down arrow key
  228.      restores to default speed.  The PageDown key will skip to the next
  229.      track, PageUp jumps back one track.  The END key will (almost)
  230.      pause the music, with the down arrow key restoring the speed.
  231.      The F1 key toggles help which lists all the keys currently available.
  232.  
  233.  
  234.      6. TEST MODE
  235.      ───────────────────────────────────────────────────────── 
  236.  
  237.      You can obtain an alternative display when playing modules from the
  238.      interactive mode by starting MODPLAY with the -t-i switches.  This
  239.      display may not update quickly enough on slower machines.
  240.  
  241.  
  242.  
  243.      7. LISTS OF MODULES
  244.      ─────────────────────────────────────────────────────────
  245.  
  246.      If like me you have hundreds of modules spread over many disks you
  247.      may find the -o option useful.  This option writes out a list of
  248.      mods in the current directory to the screen which can be redirected
  249.      to a file.   Example:
  250.  
  251.      A:\> mp -o > c:\modlist.021
  252.  
  253.      Would create a file c:\modlist.021 with the following contents
  254.  
  255.      AXELF.MOD           axel f                   15    83   110k     10:24
  256.      FCMEDINA.MOD        funky cold medina        31    31   229k     01:56
  257.      HUMANINV.MOD        human invasion           31    26   197k     03:15
  258.      KYLIEMIX.MOD        kyliemix                 15    15    59k     01:52
  259.      SJUNGLE.MOD         street jungle            31    45   135k     05:38
  260.      THEMODEL.MOD        the model                31    28    74k     03:30
  261.      MCHAMMER.ZIP        MCHAMMER.MOD             15     0   106k     00:00
  262.  
  263.  
  264.  
  265.      8. VERSION
  266.      ─────────────────────────────────────────────────────────
  267.  
  268.      The -v flag displays automatic information about your version of MODPLAY.
  269.      It will show the main version number and the exact date/time it was
  270.      compiled, for example:
  271.  
  272.      C:\> mp -v
  273.  
  274.      Program        : MODPLAY (MP.COM) 
  275.      Version        : 2.02  (October 1991)
  276.      Compiled on    : 10-10-1991 at 20:30:58
  277.      Compiled by    : Mark J Cox
  278.  
  279.  
  280.  
  281.      9. ARCHIVED MODULES
  282.      ─────────────────────────────────────────────────────────
  283.  
  284.      Using a popular archiving utility normally saves about 30% of disk space
  285.      for modules.  Support is now added so that MODPLAY will automatically 
  286.      find and play modules stored in archives (in interactive mode only at
  287.      present).   Modules can be archived into LZH or ZIP formats and there
  288.      must be only one module per archive (modules must have a .MOD extension)
  289.      MODPLAY runs your unpacker for you, creating the .MOD file temporarily on
  290.      your hard disk; plays the .MOD file then deletes it.  To play ZIP files
  291.      you must have a program or a batch file called PKUNZIP somewhere on your
  292.      path; to play LZH files you must have a program called LHARC.
  293.      If you have a better method you would like adding, please let me know.
  294.     
  295.  
  296.  
  297.      10. SOURCE OF MODULES
  298.      ─────────────────────────────────────────────────────────
  299.  
  300.      You can obtain modules from many Bulletin Boards,  Internet sites or from
  301.      friends Amiga's.  Modules usually come archived in LZH form, these can be 
  302.      unpacked with the excellent LHARC program.  The files will usually unpack 
  303.      as 'mod.something' and so MSDOS cuts them short to 'mod.SOM' and it is 
  304.      best to rename these to 'something.mod' so that MODPLAY will automatically 
  305.      detect them.
  306.  
  307.  
  308.  
  309.      11. FREEWARE
  310.      ─────────────────────────────────────────────────────────
  311.  
  312.      This software is Freeware - that means that there is no registration fee,
  313.      you can copy this software, give it to anyone, and use it for anything 
  314.      (subject to the license at the end of this document).  If you like this
  315.      software, and would like the author to continue writing-  a gift would be
  316.      appreciated, send any spare UK currency you have left (from holiday etc.)
  317.      8-)
  318.  
  319.                   *** Was free,  Is free,  Always free ***
  320.  
  321.  
  322.      12. CREDIT & THANKS DUE TO:
  323.      ─────────────────────────────────────────────────────────
  324.  
  325.      ╔════════════════════════════════════════════════════════════════════════╗
  326.      ║                                                                        ║
  327.      ║ DABS PRESS           - For providing a Soundblaster Board that enabled ║
  328.      ║ Manchester, UK         MODPLAY to finally work with it!  DABS PRESS    ║
  329.      ║                        supply PC's and a whole host of peripherals,    ║
  330.      ║                        including Soundblaster boards at excellent      ║
  331.      ║                        prices.  Look at the adverts in most UK         ║
  332.      ║                        computer magazines or ring 061-773 8632 now!    ║
  333.      ║                                                                        ║
  334.      ╚════════════════════════════════════════════════════════════════════════╝
  335.  
  336.      Mahoney & Kaktus     - A sample Amiga assembler noisetracker replay
  337.                             routine that provided some details on how a
  338.                             module was comprised and sparked the initial
  339.                             idea.
  340.  
  341.      Francois Jalbert     - For spending hours wading through my source code
  342.                             looking for a nasty bug that only seemed to occur
  343.                             when we were not looking for it - and providing
  344.                             moral support when I get bored.
  345.  
  346.      Norman Lin (Modedit) - Who pointed out a few mistakes in my
  347.                             initial implementation.   
  348.  
  349.      Derek Beacroft       - For obtaining the Soundblaster programming
  350.                             information and other ideas
  351.  
  352.      Pete Jones, Paul     - For finding all the bugs in pre-release versions
  353.      Sutton, Phil Copeland  and picking holes in the documentation
  354.  
  355.      Other tracker        - For being limited,shareware or for not working and
  356.      players/editors        hence giving me a reason to write MODPLAY.
  357.  
  358.      And the other (now over 100) people who have commented on MODPLAY and
  359.      given ideas for the future. 
  360.  
  361.  
  362.  
  363.      13. COPYRIGHT/LICENSE/WARRANTY
  364.      ─────────────────────────────────────────────────────────
  365.  
  366.      The files MP.COM, HARDWARE.DOC, WHAT.NEW and this document MP.DOC 
  367.      ("the software") are copyrighted by the author (Mark J Cox). 
  368.      The copyright owner hereby licenses you to:  use the software; 
  369.      make as many copies of the program and documentation as you wish; 
  370.      give such copies to anyone; and distribute the software and  
  371.      documentation via electronic means.  This means that as a company 
  372.      you could put MODPLAY on any of your PCs or Networks freely.
  373.     
  374.      You are specifically prohibited from charging, or requesting donations,
  375.      for  any such copies, however made; and from distributing the software
  376.      and/or  documentation with commercial products without written
  377.      contract from the author (Mark J Cox).
  378.     
  379.      This software may be distributed in Shareware/Public Domain libraries
  380.      that charge for copying and distributing disks.
  381.     
  382.      ║ No Copy Of The Software May Be Distributed Or Given Away Without   ║
  383.      ║ This Document; And Neither The Program Or Document May Be Altered  ║
  384.      ║ In Any Way, Or Reverse-Engineered By Disassembly Or Other Method.  ║
  385.     
  386.      There is no warranty of any kind, and the copyright owner is not liable
  387.      for damages of any kind.  By using this software, you agree to all the
  388.      above terms.
  389.     
  390.      The software, documentation and diagrams are  
  391.      Copyright (C) 1990/1991 by Mark J Cox
  392.  
  393.  
  394.      14. EXAMPLE QUESTIONS
  395.      ─────────────────────────────────────────────────────────
  396.      
  397.      These are a selection of comments/suggestions and questions I have
  398.      received.
  399.  
  400.      Q. I keep getting 'Divide Error' and my computer locks up
  401.      A. Some modules I have seen are corrupt - there is no way MODPLAY can 
  402.         tell and there is no time to do any checks - use the 's' command and
  403.         you should be able to see if the module has any garbage in it.
  404.  
  405.      Q. It sounds like my computer is about to explode.
  406.      A. You have a small piezo speaker - why not build a resistor D/A as
  407.         explained above or put a nice sized speaker (Radio Shack/Tandy) in
  408.         instead.
  409.  
  410.      Q. Can I edit modules?
  411.      A. Not with MODPLAY - use MODEDIT written by Norman Lin that uses
  412.         MODRES a resident version of MODPLAY
  413.  
  414.      Q. Ever thought of supporting 8 channels like 'Startreker'?
  415.      A. Yeah, but you would need a 20Mhz+ to run it...and I haven't found
  416.         enough modules that support it yet though.
  417.  
  418.      Q. I can't find this ZN426E chip
  419.      A. Try MAPLIN otherwise you could always substitute any D/A or use the 
  420.         resistor version
  421.  
  422.      Q. I really like MODPLAY
  423.      A. A gift would be appreciated :-)
  424.  
  425.      Q. "Speech on the IBM PC is not just a case of 'yet another Lotus-1-2-3'
  426.          but a basic piece of innovative software which is being incorporated
  427.          into several commercial products at this very moment.  Releasing an
  428.          un-supported non-commercial product of this nature is a highly 
  429.          irresponsible act which we cannot stand by and watch without doing our
  430.          utmost to prevent" - A UK company talking about the PLAY program.
  431.      A. (I'll let you make your own answer up, send me your favourite)
  432.  
  433.  
  434.  
  435.      15. CONTACT/SUPPORT
  436.      ─────────────────────────────────────────────────────────
  437.  
  438.      Before June 1992:
  439.      -----------------
  440.      Mark J Cox                 Electronic Mail: 
  441.      17 Kirkburn Place           (JANET) m.j.h.cox@uk.ac.bradford (UK)
  442.      Bradford                            m.j.h.cox@bradford.ac.uk (other)
  443.      W. Yorks, UK              (NETMAIL) Post a message in PLAY SUPPORT on
  444.      BD7 2BZ                             Kingdom of Greyhawk BBS
  445.                                          (+44 332 756414)
  446.      After June 1992:
  447.      ----------------
  448.      29 Lundie Close           (NETMAIL) Post a message in PLAY SUPPORT on
  449.      Stenson Fields                      Kingdom of Greyhawk BBS
  450.      Derby, UK                           (+44 332 756414)
  451.      DE2 3AN                     
  452.  
  453.      All comments on PLAY, RESPLAY, MODPLAY or future software are welcomed!
  454.      Please enclose a SSAE for quicker reply.
  455.  
  456.